{\rtf1\mac\ansicpg10000\cocoartf824\cocoasubrtf420
{\fonttbl\f0\fnil\fcharset77 LucidaGrande-Bold;\f1\fnil\fcharset77 LucidaGrande;\f2\fmodern\fcharset77 Courier;
}
{\colortbl;\red255\green255\blue255;}
\margl1440\margr1440\vieww15880\viewh11220\viewkind0
\pard\tx1440\tx2880\tx4320\tx5760\tx7200\qc

\f0\b\fs10 \cf0 \

\fs30 sshAssistant\

\fs10 \

\fs26 Version 0.8.1
\f1\b0\fs22 \
\pard\tx1440\tx2880\tx4320\tx5760\tx7200\ql\qnatural
\cf0 \
sshAssistant is an application designed to help seamlessly integrate the 
\f2 ssh-agent
\f1  and 
\f2 ssh-add
\f1  utilities with the Mac OS X user experience.  From the time that you login to your computer to the time you log off, your private key will be unlocked and available to any application that can take advantage of SSH private key authentication.\
\

\f0\b\fs26 Installing\

\f1\b0\fs22 \
sshAssistant is distributed as a package file which can be installed with the installer utility located in /Applications/Utilities (on a normal Mac OS X installation).  A double-click on the package file will launch the installer and prompt for necessary information.  Administrator access is required to install sshAssistant and you must log out in order to activate it.\
\

\f0\b\fs26 Uninstalling
\f1\b0\fs22 \
\
Simply remove the files 
\f2 /Applications/Utilities/sshAskPass.app
\f1  and 
\f2 /Library/PreferencePanes/sshAssistant.prefPane
\f1 .\
\

\f0\b\fs26 Files Installed\

\f1\b0\fs22 \

\f2 /Applications/Utilities/sshAskPass.app\

\f1\fs8 \

\fs22 This application is used at login time to request a passphrase from the user if the preference is set.  It can also be used from the Finder after login to initiate a passphrase request.\
\

\f2 /Library/preferencePanes/sshAssistant.prefPane\

\f1\fs8 \

\fs22 This is the preference pane for setting sshAssistant options.  It can be accessed from System Preferences.\
\
Additionally, a LoginHook and LogoutHook are enabled on the installing user's account which is essential for triggering the 
\f2 ssh-agent
\f1  utility (and subsequently killing it upon logout).\
\

\f0\b\fs26 Using sshAssistant\

\f1\b0\fs22 \
Once sshAssistant has been installed, it may be customized by accessing the sshAssistant preference pane from within System Preferences.  An overview of the options follows:\
\
Set CVS_RSH: this option will enable sshAssistant to set the environment variable "CVS_RSH" in "$\{HOME\}/.MacOSX/environment.plist" allowing the "Finder" and "Dock" to inherit this environment variables.  The default setting for "CVS_RSH" is "ssh".  Alternate settings can be adjusted in the "Environment Additions" field.\
\
Use ssh-add: this option will add "ssh-add" to the user preferences of "Login Items" allowing it to be started at initial login.  In the "Environment Additions" field the "SSH_ASKPASS" environment field corresponds to the application that will be started at login to prompt for a passphrase.  If "SSH_ASKPASS" is set to "<internal>" sshAskPass will be used by default.  The "DISPLAY" variable is not used and can be set to any value (this is because "ssh-add" does not use "DISPLAY" on Mac OS X, but it may if XFree86 is used).\
\
User defined ssh keys: this option allows the user to specify a different key file other than the default keys searched for by "ssh-add". This option will only work if "sshAskPass" is used in the "Use ssh-add:" option.\
\
Use keychain: this option allows the user to store the passphrase in the default keychain.\
\

\f0\b\fs26 Using sshAskPass\

\f1\b0\fs22 \
sshAskPass is usually executed by "loginwindow" at login, but may be used within the "Finder" also.  If used from within the "Finder" "ssh-add" is executed.  Depending on the environment variable "SSH_ASKPASS" sshAskPass may or may not be executed.\
\

\f0\b\fs26 Acknowledgements\

\f1\b0\fs22 \
sshAssistant is based heavily on sshLogin, which is no longer maintained by the original developer.  Michael Link kindly provided me with the source code and I have taken over maintainership and developlment of the sshLogin under the name sshAssistant.\

\f0\b\fs26 \
Feedback\

\f1\b0\fs22 \
sshAssistant is developed and maintained by Justin Mecham.  You may send feedback, bug reports, etc. to justin@aspect.net.\
}